/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.client.program;

import org.apache.flink.annotation.Internal;
import org.apache.flink.configuration.DeploymentOptions;

import java.util.Collection;

/**
 * If {@link DeploymentOptions#PROGRAM_CONFIG_ENABLED} is disabled, configurations in the user jar
 * will throw this exception.
 */
@Internal
public class MutatedConfigurationException extends Exception {

    /** Serial version UID for serialization interoperability. */
    private static final long serialVersionUID = -2417524218857151612L;

    public MutatedConfigurationException(Collection<String> errorMessages) {
        super(prettyFormat(errorMessages));
    }

    private static String prettyFormat(Collection<String> errorMessages) {
        StringBuilder builder =
                new StringBuilder("Not allowed configuration change(s) were detected:");
        for (String error : errorMessages) {
            builder.append("\n - " + error);
        }
        return builder.toString();
    }
}
